docs: clean up README usage guide#155
Open
subhajitlucky wants to merge 1 commit into
Open
Conversation
Open
There was a problem hiding this comment.
Pull request overview
This PR updates the README usage guide to better reflect the current GitHappens CLI workflow and configuration, addressing stale/broken documentation referenced in issue #114.
Changes:
- Reworks setup instructions around Python/glab prerequisites and copying
configs/*.examplefiles. - Documents the current CLI command surface (issue/MR creation, review + auto-merge, AI review, summaries, reports, deployment lookup).
- Adds troubleshooting guidance for auth/config issues and removes/rewrites outdated sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+96
to
97
| 4. An interactive project ID prompt. | ||
|
|
Comment on lines
+20
to
+21
| - Authorize glab with `glab auth login`. A GitLab access token is required; | ||
| SSH is recommended for repository access. |
Comment on lines
+265
to
+269
| ### 401 Unauthorized | ||
|
|
||
| If you get `glab: 401 Unauthorized (HTTP 401)`, run `glab auth login` again, | ||
| check `GITLAB_TOKEN` in `configs/config.ini`, and reopen your terminal. | ||
|
|
| and then reopen your terminal. | ||
| Make sure both local config files exist: | ||
|
|
||
| ```sh |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #114
Summary
configs/config.ini, prerequisites spelling,--auto_merge, and the duplicated production deployment section.Verification
git diff --checkpython3 -m py_compile gitHappens.py ai_code_review.pynpx --yes markdownlint-cli --disable MD013 MD033 MD041 -- README.md